﻿/*
* Copyright (c) 2010-2012 Tesla Engine Group
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/


using System;

namespace Tesla.Content {
    /// <summary>
    /// Interface that represents how a resource is located.
    /// </summary>
    public interface IResourceLocator {

        /// <summary>
        /// Get the fully qualified root directory that the resource locator
        /// will attempt to retrieve a resource from.
        /// </summary>
        String RootDirectory {
            get;
        }

        /// <summary>
        /// Locates a resource if it exists.
        /// </summary>
        /// <param name="assetName">Name of the resource, including its extension</param>
        /// <returns>The resource, or null if it does not exist</returns>
        IResource LocateResource(String assetName);

        /// <summary>
        /// Returns the fully qualified path to the resource.
        /// </summary>
        /// <param name="assetName">Resource name</param>
        /// <returns>Fully qualified path</returns>
        String GetFullPath(String assetName);

        /// <summary>
        /// Gets the full path relative to the resource.
        /// </summary>
        /// <param name="assetName">Resource name</param>
        /// <param name="relativeResource">The resource relative to the asset, used to locate it</param>
        /// <returns>The fully qualifed path to the asset</returns>
        String GetFullPathRelativeTo(String assetName, IResource relativeResource);
    }
}
